<?php
/**
 * Zend Framework
 *
 * LICENSE
 *
 * This source file is subject to the new BSD license that is bundled
 * with this package in the file LICENSE.txt.
 * It is also available through the world-wide-web at this URL:
 * http://framework.zend.com/license/new-bsd
 * If you did not receive a copy of the license and are unable to
 * obtain it through the world-wide-web, please send an email
 * to license@zend.com so we can send you a copy immediately.
 *
 * @category   Zend
 * @package    Zend_Tool
 * @subpackage Framework
 * @copyright  Copyright (c) 2005-2009 Zend Technologies USA Inc. (http://www.zend.com)
 * @license    http://framework.zend.com/license/new-bsd     New BSD License
 * @version    $Id: Tool.php 18951 2009-11-12 16:26:19Z alexander $
 */

/**
 * @see Zend_Tool_Framework_Metadata_Basic
 */
require_once 'Zend/Tool/Framework/Metadata/Basic.php';

/**
 * @category   Zend
 * @package    Zend_Tool
 * @copyright  Copyright (c) 2005-2009 Zend Technologies USA Inc. (http://www.zend.com)
 * @license    http://framework.zend.com/license/new-bsd     New BSD License
 */
class Zend_Tool_Framework_Metadata_Tool extends Zend_Tool_Framework_Metadata_Basic
{

	/**
	 * @var string
	 */
	protected $_type = 'Tool';

	/**#@+
	 * @var string
	 */
	protected $_clientName    = null;
	protected $_actionName    = null;
	protected $_providerName  = null;
	protected $_specialtyName = null;
	/**#@-*/

	/**#@+
	 * @var string
	 */
	protected $_clientReference = null;
	protected $_actionReference = null;
	protected $_providerReference = null;
	/**#@-*/

	public function setClientName($clientName)
	{
		$this->_clientName = $clientName;
		return $this;
	}

	public function getClientName()
	{
		return $this->_clientName;
	}

	/**
	 * setActionName()
	 *
	 * @param string $actionName
	 * @return Zend_Tool_Framework_Metadata_Tool
	 */
	public function setActionName($actionName)
	{
		$this->_actionName = $actionName;
		return $this;
	}

	/**
	 * getActionName()
	 *
	 * @return string
	 */
	public function getActionName()
	{
		return $this->_actionName;
	}

	/**
	 * setProviderName()
	 *
	 * @param string $providerName
	 * @return Zend_Tool_Framework_Metadata_Tool
	 */
	public function setProviderName($providerName)
	{
		$this->_providerName = $providerName;
		return $this;
	}

	/**
	 * getProviderName()
	 *
	 * @return string
	 */
	public function getProviderName()
	{
		return $this->_providerName;
	}

	/**
	 * setSpecialtyName()
	 *
	 * @param string $specialtyName
	 * @return Zend_Tool_Framework_Metadata_Tool
	 */
	public function setSpecialtyName($specialtyName)
	{
		$this->_specialtyName = $specialtyName;
		return $this;
	}

	/**
	 * getSpecialtyName()
	 *
	 * @return string
	 */
	public function getSpecialtyName()
	{
		return $this->_specialtyName;
	}

	/**
	 * setClientReference()
	 *
	 * @param Zend_Tool_Framework_Client_Abstract $client
	 * @return Zend_Tool_Framework_Metadata_Tool
	 */
	public function setClientReference(Zend_Tool_Framework_Client_Abstract $client)
	{
		$this->_clientReference = $client;
		return $this;
	}

	/**
	 * getClientReference()
	 *
	 * @return Zend_Tool_Framework_Client_Abstract
	 */
	public function getClientReference()
	{
		return $this->_clientReference;
	}

	/**
	 * setActionReference()
	 *
	 * @param Zend_Tool_Framework_Action_Interface $action
	 * @return Zend_Tool_Framework_Metadata_Tool
	 */
	public function setActionReference(Zend_Tool_Framework_Action_Interface $action)
	{
		$this->_actionReference = $action;
		return $this;
	}

	/**
	 * getActionReference()
	 *
	 * @return Zend_Tool_Framework_Action_Interface
	 */
	public function getActionReference()
	{
		return $this->_actionReference;
	}

	/**
	 * setProviderReference()
	 *
	 * @param Zend_Tool_Framework_Provider_Interface $provider
	 * @return Zend_Tool_Framework_Metadata_Tool
	 */
	public function setProviderReference(Zend_Tool_Framework_Provider_Interface $provider)
	{
		$this->_providerReference = $provider;
		return $this;
	}

	/**
	 * getProviderReference()
	 *
	 * @return Zend_Tool_Framework_Provider_Interface
	 */
	public function getProviderReference()
	{
		return $this->_providerReference;
	}

	/**
	 * __toString() cast to string
	 *
	 * @return string
	 */
	public function __toString()
	{
		$string = parent::__toString();
		$string .= ' (ProviderName: ' . $this->_providerName
		. ', ActionName: '     . $this->_actionName
		. ', SpecialtyName: '  . $this->_specialtyName
		. ')';

		return $string;
	}

}
